home *** CD-ROM | disk | FTP | other *** search
/ Belgian Amiga Club - ADF Collection / BS1 part 05.zip / BS1 part 5 / GOD14-(412)695-3647.adf / SwitcherV1.10.DOC.pp / SwitcherV1.10.DOC
Text File  |  1992-08-04  |  13KB  |  337 lines
  1. Switcher 1.10
  2. -------------
  3.  
  4. By: Khalid Aldoseri.
  5.  
  6.  
  7.     Switcher's job is to provide you with a list of the current screens
  8.     existing on the system and then allow you to select which screen
  9.     you want to switch to.
  10.  
  11.  
  12. Running Switcher:
  13.  
  14.     To run it, just execute it from a CLI.  It takes no CLI arguments.
  15.  
  16.     e.g.:   Switcher
  17.  
  18.     (Make sure it only is run once.  It will not appear in the 'status'
  19.     command since it detaches itself.)
  20.  
  21.     Also, copy the Switcher.config file to S: after modifying it to
  22.     your requirements.  (Read section of configuration file.)
  23.  
  24.  
  25. Using Switcher:
  26.  
  27.     At any time just hit both mouse buttons at the same time.  (You won't
  28. get a response until you release the buttons.)  The way to do this it to
  29. click the right button first, then the left button, then release the
  30. left, the release the right.  (sounds complicated, but it isn't).
  31. You will then get a window with the list of the screens in the system,
  32. except the one you are currently one.  So, if there are 3 screens, the
  33. Switcher window will show you two.
  34.  
  35.     Note: If you have a 3 button mouse, you can use the middle mouse button
  36. as the trigger to bring up Switcher instead of hitting the left and right
  37. mouse buttons.  This is always active unless you use the -2 option, which
  38. disables it.  The -3 option disables the left+right button sequence and
  39. allows only the middle button sequence.  (Read the section on configuation
  40. file.)
  41.  
  42.     You can also call up Switcher by hitting the RAmiga-RShift-TAB key
  43. combination.
  44.  
  45.     Once you get the Switcher window you can select the screen to go to
  46. by clicking the left mouse button when it is highlighted.  Switcher will
  47. then close its window and bring the selected screen to the front.
  48.  
  49.  
  50.     If you use the right mouse button instead of the left one, then the
  51. selected screen will come to the front, but Switcher will then again bring
  52. up its window on that screen and allow you to select another screen.
  53.  
  54.  
  55.     To abort the screen selection, just click on any other window, or move
  56. the mouse away above or below Switcher's window so that nothing is
  57. highlighted, and then hit the right mouse button.
  58.  
  59.  
  60.     The Switcher's window will disappear on its own if:
  61.  
  62.     a. The mouse or keyboard aren't used for 30 seconds.
  63.     b. Any other window is activated by the user.
  64.  
  65.  
  66.     If the screen that Switcher's window is supposed to show up on cannot
  67. automatically restore its contents after Switcher has gone, then Switcher
  68. will temporarily blank out that screen and bring up its window on a blank
  69. screen.  In this case, the screen that you were on will show up in the
  70. Switcher list.  (It will always be the first in the list.)
  71.  
  72.  
  73.     If a program suddenly decides to close its screen which Switcher's
  74. window is on it, Switcher will automatically recover and show up again on
  75. the new front screen.  Also, Switcher checks for the screen's existance
  76. just before bringing it to the front in order to be 100% sure that the
  77. screen wasn't closed down in the time between the last time that the
  78. screen list was updated (16 times a second) and the time the user clicked
  79. on a selection.  (Being real paranoid here, but I'll do anything to avoid
  80. a guru! :-)
  81.  
  82.  
  83.     You can drag Switcher's window around.  The drag bar is the top title
  84. line.
  85.  
  86.  
  87.     At the bottom of the window there are six gadgets.  To use those, just
  88. click in the gadget with the left mouse button.  The following is what each
  89. gadget does:
  90.  
  91.  
  92.     Remove: This will quit Switcher.  It will disappear and will
  93.             unload itself.
  94.  
  95.     Cycle : This will show you all the screens in the system one by
  96.             one.  To stop the cycling, just hold the right mouse button.
  97.             You can also use the middle mouse button or both left and
  98.             right buttons to both cancel the cycling and bring Switcher's
  99.             window up on the screen you stopped the cycling at.
  100.  
  101.     Help  : Brings up a help screen that shows all the keyboard shortcuts
  102.             allowable.
  103.  
  104.     Save  : Save current screen.   Read below.
  105.  
  106.     Window:
  107.     Screen: These are both one gadget that changes text based on the current
  108.             Switcher mode.  The normal is Screen mode.  If you click on this
  109.             gadget, the mode will change to Window mode, where the normal
  110.             list gets replaced with the list of the windows in the current
  111.             screen allowing you to select a window that will be brought to
  112.             the front, or even cycle the windows.  The window list will only
  113.             contains windows that can be brought to front.  Windows that are
  114.             backdrops (such as the Workbench window) or those that do not
  115.             have depth arrangement gadgets will not show up on the list.
  116.             The window that is brought to front is also activated.
  117.             This gadget toggles back and forth between Screen and Window
  118.             modes.
  119.  
  120.             You can also click the right mouse button when you are on
  121.             the top (drag) strip in order to switch modes.
  122.  
  123.     Switch: The 'Switch' gadget is a small, one character gadget at the
  124.             end of the gadget strip.  It allows you to switch between strips
  125.             of gadgets.  The first strip has the 5 gadgets mentioned above.
  126.             Then there are up to 8 more strips each containing up to 5 user
  127.             defined gadgets.  The Switch gadget itself contains the strip
  128.             number of the current strip, from 1 to 9.
  129.  
  130.             You can also click the right mouse button when you are on
  131.             any gadget in the gadget strip in order to switch strips.
  132.  
  133.  
  134.     Some gadgets will disappear in certain cases, not allowing you to select
  135.     them.  For example, if the screen list has no entries, the 'Cycle'
  136.     gadget will disappear. Or, if there are no user defined gadgets then the
  137.     Switch gadget will not appear.
  138.  
  139.  
  140.     CONFIGURATION FILE:
  141.     -------------------
  142.  
  143.     Switcher reads in a configuration file that controls how Switcher works.
  144.     This file is always placed in the S: directory as  S:Switcher.config
  145.  
  146.     The example Switcher.config file provided has all the details on how
  147.     to write the config file.
  148.  
  149.  
  150.     COMMAND GADGETS:
  151.     ----------------
  152.  
  153.     The second set of gadgets contain 5 user definable gadgets that execute
  154.     any normal CLI command.  You need to define those gadgets in the
  155.     config file:
  156.  
  157.     e.g.:
  158.  
  159.     DSD    DSD
  160.     Prefs  SYS:Preferences/Prefs
  161.     AMon   utils:AmigaMonitor
  162.     Shell  NewShell "CON:0/0/640/200/My Shell!"
  163.  
  164.     You can specify upto 40 gadgets.
  165.  
  166.     Look at the provided example Switcher.config file to see the remaining
  167.     details.
  168.  
  169.  
  170.     SAVE GADGET:
  171.     ------------
  172.  
  173.     The 'Save' gadget will save the screen you were on to a file.  The
  174.     file name will be:  RAM:screenname.PIC
  175.  
  176.     Where screenname is the name of the screen that was saved.
  177.     Switcher's window will go away immediately after selecting
  178.     'Save' and it will start saving the screen.  I would advise that
  179.     you don't change anything in the screen while it is being saved.
  180.     (this takes from 1 to 10 seconds)
  181.  
  182.     Note: screenname will always be truncated to a maximum of 26 characters.
  183.     The filename for the Save will be checked for illegal filename characters
  184.     and these will be replaced by other characters as follows:
  185.  
  186.             From   To
  187.             ----   --
  188.              :     |
  189.              /     \
  190.              "     '
  191.              #     @
  192.              ?     !
  193.              *     X
  194.  
  195.  
  196.     Important:
  197.  
  198.     To use this function you must copy the 'pic.library' file to your
  199.     LIBS: directory.  This library was written by Christian Weber of
  200.     Zurich, Switzerland as 'iff.library'.  I have, however, changed its
  201.     name to 'pic.library' since there were several different 'iff.library'
  202.     files out there, and the potential for a big mess was present.
  203.     The 'Save' function can save any screen including HAM screens.
  204.  
  205.  
  206.     Window Save:
  207.  
  208.     If Switcher is in 'Window' mode, then it will attempt to save the window
  209.     that was active right before Switcher was activated, or the last window
  210.     selected via Switcher.  This will save the part of the screen that
  211.     corresponds to the active window's location and size.  However, due to
  212.     the way the Amiga graphics work, the left edge and width of the window
  213.     can only be saved to a precision or +/- 8 pixels.  Because of this, the
  214.     window save might be as much as +15 pixels in width more than it should
  215.     be.  
  216.  
  217.     Note: Switcher will attempt to open the 'pic.library' as soon as it
  218.     loads.  If it can't find the library, it will disable the 'Save' gadget
  219.     and that gadget will never appear.
  220.  
  221.     Another note:  While Switcher is doing the save its priority is bumped
  222.     up temporarily to +4.  This allows it to get done with the save a bit
  223.     faster if there are other programs doing lots of work at the same time.
  224.  
  225.  
  226.  
  227.     KEYBOARD SHORTCUTS:
  228.     -------------------
  229.  
  230.     When Switcher's window is active you can use the keyboard to issue some
  231.     commands.  The following is the list of these keyboard shortcuts:
  232.  
  233.     c        Toggle between single and 2 color mode.
  234.     
  235.     v        Save  (either Screen or Window depending on current mode)
  236.  
  237.     m        Toggle between Screen and Window modes.
  238.  
  239.     s        Switch to Screen mode.
  240.  
  241.     w        Switch to Window mode.
  242.  
  243.     y        Cycle.
  244.  
  245.     q        Quit.  (only closes window, doesn't remove Switcher)
  246.  
  247.     <return> Does the same job as 'q'.  (so does <enter> and <escape> )
  248.  
  249.     !        Remove.  (unloads Switcher)
  250.  
  251.     1-9,0    This will bring the specified screen/window to front.  The
  252.              number corresponds to the serial number of the screen/window.
  253.              E.g. hitting '5' will bring up the fifth screen/window in the
  254.              list to the front.  '0' will bring up the 10th screen/window.
  255.              If the requested number doesn't exist, the command will be
  256.              ignored.  Switcher's window will come back up on the new
  257.              screen.  Use 'q' or <enter> or <return> to get rid of it.
  258.  
  259.     + or =   This allows the above keys (1-9,0) to select the first ten
  260.              or second ten screens.  When you hit the + or = for the first
  261.              time, the second ten screens/windows will be marked with a
  262.              '+' sign.  Hitting + or = again will cancel that.  E.g. to
  263.              select the 13th screen/window, hit + or = then 3.  The marker
  264.              is reset whenever Switcher's window is closed.  If the number
  265.              of screens/windows is less than 11 this command has no effect.
  266.  
  267.     A-Z      This will trigger one of the user-defined commands.  The 'A'
  268.              stands for the first user-defined command, and the 'Z' stands
  269.              for the 26th one.  (get it?)  Note: Use the shift-letter.
  270.  
  271.     <space>  Hitting the space bar increments the strip number and updates
  272.              the strip display.
  273.  
  274.     h        Brings up a help screen that lists what each of the above
  275.              keys do, and also lists the first 26 user-defined commands
  276.              and the shift-letter key that would trigger each command.
  277.  
  278.     F1-F5    Trigger gadget 1 to 5 from bottom gadget strip.
  279.  
  280.  
  281.     HOTKEYS:
  282.     --------
  283.  
  284.     Hotkeys are keys that are active even if the Switcher window is not up.
  285.  
  286.     - RightShift/RightAmiga/TAB:
  287.  
  288.       This hotkey will bring up the Switcher window if it isn't active.
  289.  
  290.  
  291.     - Control/LeftShift/Letter:
  292.  
  293.       This will trigger one of the user defined commands.  'a' stands for the
  294.       first command until 'z', which is the 26th command defined.
  295.  
  296.       e.g. To execute the fourth user command, hit  control/leftshift/d
  297.  
  298.  
  299.  
  300.     Happy Switching!
  301.  
  302.  
  303.     Please report any bugs, comments, etc. to me on CIS 75166,2531.
  304.  
  305.  
  306.     Khalid Aldoseri.
  307.  
  308.  
  309.  
  310. Now for the serious stuff:
  311.  
  312. This program and all the accompanying files are freely distributable.
  313. You can spread them around as much as you like as long as you do it
  314. in the original LHARC file form or, if not, as the full package.  You
  315. many NOT sell the program itself or any of the accompanying files.
  316. If you would like to include it with any commercial package please
  317. contact me first.  All the files are (c) 1990-92 by Khalid Aldoseri, except
  318. pic.library, which was originally named iff.library and was written by
  319. Christian Weber of Zurich, Switzerland.  I am not responsible for any
  320. thing that you do with Switcher, including ruining your mouse by clicking
  321. on both buttons too much.  (grin)
  322.  
  323.  
  324.  
  325.                       /-------------------\
  326.                       | Khalid Aldoseri   |
  327.                       | P.O. Box 3300     |
  328.                       | Manama, Bahrain.  |
  329.                       | Fax: (973) 694777 |
  330.                       \-------------------/
  331.  
  332.                       Compuserve 75166,2531
  333.  
  334.  
  335.                   Copyright 1990-92  Khalid Aldoseri.
  336.                            3 May 1992.
  337.